home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 4 / Apprentice-Release4.iso / Source Code / C / Applications / Portable Patmos / usr / include / sys / mbuf.h < prev    next >
Encoding:
C/C++ Source or Header  |  1994-11-08  |  12.5 KB  |  389 lines  |  [TEXT/R*ch]
  1. /*
  2.  * Copyright (c) 1982, 1986, 1988 Regents of the University of California.
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  * 1. Redistributions of source code must retain the above copyright
  9.  *    notice, this list of conditions and the following disclaimer.
  10.  * 2. Redistributions in binary form must reproduce the above copyright
  11.  *    notice, this list of conditions and the following disclaimer in the
  12.  *    documentation and/or other materials provided with the distribution.
  13.  * 3. All advertising materials mentioning features or use of this software
  14.  *    must display the following acknowledgement:
  15.  *    This product includes software developed by the University of
  16.  *    California, Berkeley and its contributors.
  17.  * 4. Neither the name of the University nor the names of its contributors
  18.  *    may be used to endorse or promote products derived from this software
  19.  *    without specific prior written permission.
  20.  *
  21.  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22.  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24.  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25.  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26.  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27.  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28.  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29.  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30.  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31.  * SUCH DAMAGE.
  32.  *
  33.  *    from: @(#)mbuf.h    7.14 (Berkeley) 12/5/90
  34.  *    $Id: mbuf.h,v 1.4 1993/08/03 01:50:21 glass Exp $
  35.  */
  36.  
  37. #ifndef _SYS_MBUF_H_
  38. #define _SYS_MBUF_H_
  39.  
  40. #ifndef M_WAITOK
  41. #include "malloc.h"
  42. #endif
  43.  
  44. /*
  45.  * Mbufs are of a single size, MSIZE (machine/machparam.h), which
  46.  * includes overhead.  An mbuf may add a single "mbuf cluster" of size
  47.  * MCLBYTES (also in machine/machparam.h), which has no additional overhead
  48.  * and is used instead of the internal data area; this is done when
  49.  * at least MINCLSIZE of data must be stored.
  50.  */
  51.  
  52. #define    MLEN        (MSIZE - sizeof(struct m_hdr))    /* normal data len */
  53. #define    MHLEN        (MLEN - sizeof(struct pkthdr))    /* data len w/pkthdr */
  54.  
  55. #define    MINCLSIZE    (MHLEN + MLEN)    /* smallest amount to put in cluster */
  56. #define    M_MAXCOMPRESS    (MHLEN / 2)    /* max amount to copy for compression */
  57.  
  58. /*
  59.  * Macros for type conversion
  60.  * mtod(m,t) -    convert mbuf pointer to data pointer of correct type
  61.  * dtom(x) -    convert data pointer within mbuf to mbuf pointer (XXX)
  62.  * mtocl(x) -    convert pointer within cluster to cluster index #
  63.  * cltom(x) -    convert cluster # to ptr to beginning of cluster
  64.  */
  65. #define mtod(m,t)    ((t)((m)->m_data))
  66. #define    dtom(x)        ((struct mbuf *)((int)(x) & ~(MSIZE-1)))
  67. #define    mtocl(x)    (((u_int)(x) - (u_int)mbutl) >> MCLSHIFT)
  68. #define    cltom(x)    ((caddr_t)((u_int)mbutl + ((u_int)(x) >> MCLSHIFT)))
  69.  
  70. /* header at beginning of each mbuf: */
  71. struct m_hdr {
  72.     struct    mbuf *mh_next;        /* next buffer in chain */
  73.     struct    mbuf *mh_nextpkt;    /* next chain in queue/record */
  74.     int    mh_len;            /* amount of data in this mbuf */
  75.     caddr_t    mh_data;        /* location of data */
  76.     short    mh_type;        /* type of data in this mbuf */
  77.     short    mh_flags;        /* flags; see below */
  78. };
  79.  
  80. /* record/packet header in first mbuf of chain; valid if M_PKTHDR set */
  81. struct    pkthdr {
  82.     int    len;        /* total packet length */
  83.     struct    ifnet *rcvif;    /* rcv interface */
  84. };
  85.  
  86. /* description of external storage mapped into mbuf, valid if M_EXT set */
  87. struct m_ext {
  88.     caddr_t    ext_buf;        /* start of buffer */
  89.     void    (*ext_free)();        /* free routine if not the usual */
  90.     u_int    ext_size;        /* size of buffer, for ext_free */
  91. };
  92.  
  93. struct mbuf {
  94.     struct    m_hdr m_hdr;
  95.     union {
  96.         struct {
  97.             struct    pkthdr MH_pkthdr;    /* M_PKTHDR set */
  98.             union {
  99.                 struct    m_ext MH_ext;    /* M_EXT set */
  100.                 char    MH_databuf[MHLEN];
  101.             } MH_dat;
  102.         } MH;
  103.         char    M_databuf[MLEN];        /* !M_PKTHDR, !M_EXT */
  104.     } M_dat;
  105. };
  106. #define    m_next        m_hdr.mh_next
  107. #define    m_len        m_hdr.mh_len
  108. #define    m_data        m_hdr.mh_data
  109. #define    m_type        m_hdr.mh_type
  110. #define    m_flags        m_hdr.mh_flags
  111. #define    m_nextpkt    m_hdr.mh_nextpkt
  112. #define    m_act        m_nextpkt
  113. #define    m_pkthdr    M_dat.MH.MH_pkthdr
  114. #define    m_ext        M_dat.MH.MH_dat.MH_ext
  115. #define    m_pktdat    M_dat.MH.MH_dat.MH_databuf
  116. #define    m_dat        M_dat.M_databuf
  117.  
  118. /* mbuf flags */
  119. #define    M_EXT        0x0001    /* has associated external storage */
  120. #define    M_PKTHDR    0x0002    /* start of record */
  121. #define    M_EOR        0x0004    /* end of record */
  122.  
  123. /* mbuf pkthdr flags, also in m_flags */
  124. #define    M_BCAST        0x0100    /* send/received as link-level broadcast */
  125. #define    M_MCAST        0x0200    /* send/received as link-level multicast */
  126.  
  127. /* flags copied when copying m_pkthdr */
  128. #define    M_COPYFLAGS    (M_PKTHDR|M_EOR|M_BCAST|M_MCAST)
  129.  
  130. /* mbuf types */
  131. #define    MT_FREE        0    /* should be on free list */
  132. #define    MT_DATA        1    /* dynamic (data) allocation */
  133. #define    MT_HEADER    2    /* packet header */
  134. #define    MT_SOCKET    3    /* socket structure */
  135. #define    MT_PCB        4    /* protocol control block */
  136. #define    MT_RTABLE    5    /* routing tables */
  137. #define    MT_HTABLE    6    /* IMP host tables */
  138. #define    MT_ATABLE    7    /* address resolution tables */
  139. #define    MT_SONAME    8    /* socket name */
  140. #define    MT_SOOPTS    10    /* socket options */
  141. #define    MT_FTABLE    11    /* fragment reassembly header */
  142. #define    MT_RIGHTS    12    /* access rights */
  143. #define    MT_IFADDR    13    /* interface address */
  144. #define MT_CONTROL    14    /* extra-data protocol message */
  145. #define MT_OOBDATA    15    /* expedited data  */
  146.  
  147. /* flags to m_get/MGET */
  148. #define    M_DONTWAIT    M_NOWAIT
  149. #define    M_WAIT        M_WAITOK
  150.  
  151. /*
  152.  * mbuf allocation/deallocation macros:
  153.  *
  154.  *    MGET(struct mbuf *m, int how, int type)
  155.  * allocates an mbuf and initializes it to contain internal data.
  156.  *
  157.  *    MGETHDR(struct mbuf *m, int how, int type)
  158.  * allocates an mbuf and initializes it to contain a packet header
  159.  * and internal data.
  160.  */
  161. #define    MGET(m, how, type) { \
  162.     MALLOC((m), struct mbuf *, MSIZE, mbtypes[type], (how)); \
  163.     if (m) { \
  164.         (m)->m_type = (type); \
  165.         mbstat.m_mtypes[type]++; \
  166.         (m)->m_next = (struct mbuf *)NULL; \
  167.         (m)->m_nextpkt = (struct mbuf *)NULL; \
  168.         (m)->m_data = (m)->m_dat; \
  169.         (m)->m_flags = 0; \
  170.     } else \
  171.         (m) = m_retry((how), (type)); \
  172. }
  173.  
  174. #define    MGETHDR(m, how, type) { \
  175.     MALLOC((m), struct mbuf *, MSIZE, mbtypes[type], (how)); \
  176.     if (m) { \
  177.         (m)->m_type = (type); \
  178.         mbstat.m_mtypes[type]++; \
  179.         (m)->m_next = (struct mbuf *)NULL; \
  180.         (m)->m_nextpkt = (struct mbuf *)NULL; \
  181.         (m)->m_data = (m)->m_pktdat; \
  182.         (m)->m_flags = M_PKTHDR; \
  183.     } else \
  184.         (m) = m_retryhdr((how), (type)); \
  185. }
  186.  
  187. /*
  188.  * Mbuf cluster macros.
  189.  * MCLALLOC(caddr_t p, int how) allocates an mbuf cluster.
  190.  * MCLGET adds such clusters to a normal mbuf;
  191.  * the flag M_EXT is set upon success.
  192.  * MCLFREE releases a reference to a cluster allocated by MCLALLOC,
  193.  * freeing the cluster if the reference count has reached 0.
  194.  *
  195.  * Normal mbuf clusters are normally treated as character arrays
  196.  * after allocation, but use the first word of the buffer as a free list
  197.  * pointer while on the free list.
  198.  */
  199. union mcluster {
  200.     union    mcluster *mcl_next;
  201.     char    mcl_buf[MCLBYTES];
  202. };
  203.  
  204. #define    MCLALLOC(p, how) \
  205.     { int ms = splimp(); \
  206.       if (mclfree == 0) \
  207.         (void)m_clalloc(1, (how)); \
  208.       if ((p) = (caddr_t)mclfree) { \
  209.         ++mclrefcnt[mtocl(p)]; \
  210.         mbstat.m_clfree--; \
  211.         mclfree = ((union mcluster *)(p))->mcl_next; \
  212.       } \
  213.       splx(ms); \
  214.     }
  215.  
  216. #define    MCLGET(m, how) \
  217.     { MCLALLOC((m)->m_ext.ext_buf, (how)); \
  218.       if ((m)->m_ext.ext_buf != NULL) { \
  219.         (m)->m_data = (m)->m_ext.ext_buf; \
  220.         (m)->m_flags |= M_EXT; \
  221.         (m)->m_ext.ext_size = MCLBYTES;  \
  222.       } \
  223.     }
  224.  
  225. #define    MCLFREE(p) \
  226.     { int ms = splimp(); \
  227.       if (--mclrefcnt[mtocl(p)] == 0) { \
  228.         ((union mcluster *)(p))->mcl_next = mclfree; \
  229.         mclfree = (union mcluster *)(p); \
  230.         mbstat.m_clfree++; \
  231.       } \
  232.       splx(ms); \
  233.     }
  234.  
  235. /*
  236.  * MFREE(struct mbuf *m, struct mbuf *n)
  237.  * Free a single mbuf and associated external storage.
  238.  * Place the successor, if any, in n.
  239.  */
  240. #ifdef notyet
  241. #define    MFREE(m, n) \
  242.     { mbstat.m_mtypes[(m)->m_type]--; \
  243.       if ((m)->m_flags & M_EXT) { \
  244.         if ((m)->m_ext.ext_free) \
  245.             (*((m)->m_ext.ext_free))((m)->m_ext.ext_buf, \
  246.                 (m)->m_ext.ext_size); \
  247.         else \
  248.             MCLFREE((m)->m_ext.ext_buf); \
  249.       } \
  250.       (n) = (m)->m_next; \
  251.       FREE((m), mbtypes[(m)->m_type]); \
  252.     }
  253. #else /* notyet */
  254. #define    MFREE(m, nn) \
  255.     { mbstat.m_mtypes[(m)->m_type]--; \
  256.       if ((m)->m_flags & M_EXT) { \
  257.         MCLFREE((m)->m_ext.ext_buf); \
  258.       } \
  259.       (nn) = (m)->m_next; \
  260.       FREE((m), mbtypes[(m)->m_type]); \
  261.     }
  262. #endif
  263.  
  264. /*
  265.  * Copy mbuf pkthdr from from to to.
  266.  * from must have M_PKTHDR set, and to must be empty.
  267.  */
  268. #define    M_COPY_PKTHDR(to, from) { \
  269.     (to)->m_pkthdr = (from)->m_pkthdr; \
  270.     (to)->m_flags = (from)->m_flags & M_COPYFLAGS; \
  271.     (to)->m_data = (to)->m_pktdat; \
  272. }
  273.  
  274. /*
  275.  * Set the m_data pointer of a newly-allocated mbuf (m_get/MGET) to place
  276.  * an object of the specified size at the end of the mbuf, longword aligned.
  277.  */
  278. #define    M_ALIGN(m, len) \
  279.     { (m)->m_data += (MLEN - (len)) &~ (sizeof(long) - 1); }
  280. /*
  281.  * As above, for mbufs allocated with m_gethdr/MGETHDR
  282.  * or initialized by M_COPY_PKTHDR.
  283.  */
  284. #define    MH_ALIGN(m, len) \
  285.     { (m)->m_data += (MHLEN - (len)) &~ (sizeof(long) - 1); }
  286.  
  287. /*
  288.  * Compute the amount of space available
  289.  * before the current start of data in an mbuf.
  290.  */
  291. #define    M_LEADINGSPACE(m) \
  292.     ((m)->m_flags & M_EXT ? /* (m)->m_data - (m)->m_ext.ext_buf */ 0 : \
  293.         (m)->m_flags & M_PKTHDR ? (m)->m_data - (m)->m_pktdat : \
  294.         (m)->m_data - (m)->m_dat)
  295.  
  296. /*
  297.  * Compute the amount of space available
  298.  * after the end of data in an mbuf.
  299.  */
  300. #define    M_TRAILINGSPACE(m) \
  301.     ((m)->m_flags & M_EXT ? (m)->m_ext.ext_buf + (m)->m_ext.ext_size - \
  302.         ((m)->m_data + (m)->m_len) : \
  303.         &(m)->m_dat[MLEN] - ((m)->m_data + (m)->m_len))
  304.  
  305. /*
  306.  * Arrange to prepend space of size plen to mbuf m.
  307.  * If a new mbuf must be allocated, how specifies whether to wait.
  308.  * If how is M_DONTWAIT and allocation fails, the original mbuf chain
  309.  * is freed and m is set to NULL.
  310.  */
  311. #define    M_PREPEND(m, plen, how) { \
  312.     if (M_LEADINGSPACE(m) >= (plen)) { \
  313.         (m)->m_data -= (plen); \
  314.         (m)->m_len += (plen); \
  315.     } else \
  316.         (m) = m_prepend((m), (plen), (how)); \
  317.     if ((m) && (m)->m_flags & M_PKTHDR) \
  318.         (m)->m_pkthdr.len += (plen); \
  319. }
  320.  
  321. /* change mbuf to new type */
  322. #define MCHTYPE(m, t) { \
  323.     mbstat.m_mtypes[(m)->m_type]--; \
  324.     mbstat.m_mtypes[t]++; \
  325.     (m)->m_type = t;\
  326. }
  327.  
  328. /* length to m_copy to copy all */
  329. #define    M_COPYALL    1000000000
  330.  
  331. /* compatiblity with 4.3 */
  332. #define  m_copy(m, o, l)    m_copym((m), (o), (l), M_DONTWAIT)
  333.  
  334. /*
  335.  * Mbuf statistics.
  336.  */
  337. struct mbstat {
  338.     u_long    m_mbufs;    /* mbufs obtained from page pool */
  339.     u_long    m_clusters;    /* clusters obtained from page pool */
  340.     u_long    m_spare;    /* spare field */
  341.     u_long    m_clfree;    /* free clusters */
  342.     u_long    m_drops;    /* times failed to find space */
  343.     u_long    m_wait;        /* times waited for space */
  344.     u_long    m_drain;    /* times drained protocols for space */
  345.     u_short    m_mtypes[256];    /* type specific mbuf allocations */
  346. };
  347.  
  348. #ifdef    KERNEL
  349. extern    struct mbuf *mbutl;        /* virtual address of mclusters */
  350. extern    char *mclrefcnt;        /* cluster reference counts */
  351. struct    mbstat mbstat;
  352. int    nmbclusters;
  353. union    mcluster *mclfree;
  354. int    max_linkhdr;            /* largest link-level header */
  355. int    max_protohdr;            /* largest protocol header */
  356. int    max_hdr;            /* largest link+protocol header */
  357. int    max_datalen;            /* MHLEN - max_hdr */
  358. struct    mbuf *m_get(), *m_gethdr(), *m_getclr(), *m_retry(), *m_retryhdr();
  359. struct    mbuf *m_free(), *m_copym(), *m_pullup(), *m_prepend();
  360. int    m_clalloc();
  361. extern    int mbtypes[];            /* XXX */
  362.  
  363. #ifdef MBTYPES                    
  364. int mbtypes[] = {                    /* XXX */
  365.     M_FREE,        /* MT_FREE    0        * should be on free list */
  366.     M_MBUF,        /* MT_DATA    1        * dynamic (data) allocation */
  367.     M_MBUF,        /* MT_HEADER    2        * packet header */
  368.     M_SOCKET,    /* MT_SOCKET    3        * socket structure */
  369.     M_PCB,        /* MT_PCB    4        * protocol control block */
  370.     M_RTABLE,    /* MT_RTABLE    5        * routing tables */
  371.     M_HTABLE,    /* MT_HTABLE    6        * IMP host tables */
  372.     0,        /* MT_ATABLE    7        * address resolution tables */
  373.     M_MBUF,        /* MT_SONAME    8        * socket name */
  374.     0,        /*         9 */    
  375.     M_SOOPTS,    /* MT_SOOPTS    10       * socket options */
  376.     M_FTABLE,    /* MT_FTABLE    11       * fragment reassembly header */
  377.     M_MBUF,        /* MT_RIGHTS    12       * access rights */
  378.     M_IFADDR,    /* MT_IFADDR    13       * interface address */
  379.     M_MBUF,        /* MT_CONTROL    14       * extra-data protocol message */
  380.     M_MBUF,        /* MT_OOBDATA    15     * expedited data  */
  381. #ifdef DATAKIT                    
  382.     25, 26, 27, 28, 29, 30, 31, 32        /* datakit ugliness */
  383. #endif
  384. };
  385. #endif
  386. #endif
  387.  
  388. #endif /* !_SYS_MBUF_H_ */
  389.